Skip to content

feat: keep debug symbols in release builds#6894

Merged
DaniPopes merged 1 commit intomasterfrom
dani/keep-symbols
Jan 24, 2024
Merged

feat: keep debug symbols in release builds#6894
DaniPopes merged 1 commit intomasterfrom
dani/keep-symbols

Conversation

@DaniPopes
Copy link
Member

@DaniPopes DaniPopes commented Jan 24, 2024 •
edited
Loading

And always show backtraces on panics.

This is a 10% size increase (40M -> 44M) for much better debugging panics. See below.

Benchmarks

NOTE: forge-<strip = >-<panic = >


------------- PANIC= ./forge-debuginfo-abort
The application panicked (crashed).
Message:  test
Location: crates/forge/bin/main.rs:25

This is a bug. Consider reporting it at https://github.com/foundry-rs/foundry

  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                ⋮ 7 frames hidden ⋮                               
   8: forge::main::hd66a31dbefd0b4bf
      at <unknown source file>:<unknown line>
   9: std::sys_common::backtrace::__rust_begin_short_backtrace::h621274431205cf82
      at <unknown source file>:<unknown line>
  10: std::rt::lang_start::{{closure}}::h2b3f351f16e75c4f
      at <unknown source file>:<unknown line>
  11: std::rt::lang_start_internal::hf76339a38b4f124b
      at <unknown source file>:<unknown line>
  12: main<unknown>
      at <unknown source file>:<unknown line>
  13: __libc_start_main<unknown>
      at <unknown source file>:<unknown line>
  14: _start<unknown>
      at <unknown source file>:<unknown line>

Run with COLORBT_SHOW_HIDDEN=1 environment variable to disable frame filtering.
./test.sh: line 9: 2131946 Aborted                 (core dumped) RUST_BACKTRACE=full PANIC=$panic $bin

------------- PANIC= ./forge-debuginfo-unwind
The application panicked (crashed).
Message:  test
Location: crates/forge/bin/main.rs:23

This is a bug. Consider reporting it at https://github.com/foundry-rs/foundry

  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                ⋮ 7 frames hidden ⋮                               
   8: forge::main::h5069bbdeccde792d
      at <unknown source file>:<unknown line>
   9: std::sys_common::backtrace::__rust_begin_short_backtrace::h21681e747fd41e51
      at <unknown source file>:<unknown line>
  10: std::rt::lang_start::{{closure}}::h6ed8ba4300b81c2a
      at <unknown source file>:<unknown line>
  11: std::rt::lang_start_internal::hf76339a38b4f124b
      at <unknown source file>:<unknown line>
  12: main<unknown>
      at <unknown source file>:<unknown line>
  13: __libc_start_main<unknown>
      at <unknown source file>:<unknown line>
  14: _start<unknown>
      at <unknown source file>:<unknown line>

Run with COLORBT_SHOW_HIDDEN=1 environment variable to disable frame filtering.

------------- PANIC= ./forge-symbols-abort
The application panicked (crashed).
Message:  test
Location: crates/forge/bin/main.rs:25

This is a bug. Consider reporting it at https://github.com/foundry-rs/foundry

  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
   1: __libc_start_main<unknown>
      at <unknown source file>:<unknown line>

Run with COLORBT_SHOW_HIDDEN=1 environment variable to disable frame filtering.
./test.sh: line 9: 2131968 Aborted                 (core dumped) RUST_BACKTRACE=full PANIC=$panic $bin

------------- PANIC= ./forge-symbols-unwind
The application panicked (crashed).
Message:  test
Location: crates/forge/bin/main.rs:25

This is a bug. Consider reporting it at https://github.com/foundry-rs/foundry

  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
   1: __libc_start_main<unknown>
      at <unknown source file>:<unknown line>

Run with COLORBT_SHOW_HIDDEN=1 environment variable to disable frame filtering.

------------- PANIC=untracked ./forge-debuginfo-abort
The application panicked (crashed).
Message:  align_offset: align is not a power-of-two
Location: /rustc/62d7ed4a6775c4490e493093ca98ef7c215b835b/library/core/src/ptr/const_ptr.rs:1368

This is a bug. Consider reporting it at https://github.com/foundry-rs/foundry

  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                ⋮ 7 frames hidden ⋮                               
   8: forge::main::hd66a31dbefd0b4bf
      at <unknown source file>:<unknown line>
   9: std::sys_common::backtrace::__rust_begin_short_backtrace::h621274431205cf82
      at <unknown source file>:<unknown line>
  10: std::rt::lang_start::{{closure}}::h2b3f351f16e75c4f
      at <unknown source file>:<unknown line>
  11: std::rt::lang_start_internal::hf76339a38b4f124b
      at <unknown source file>:<unknown line>
  12: main<unknown>
      at <unknown source file>:<unknown line>
  13: __libc_start_main<unknown>
      at <unknown source file>:<unknown line>
  14: _start<unknown>
      at <unknown source file>:<unknown line>

Run with COLORBT_SHOW_HIDDEN=1 environment variable to disable frame filtering.
./test.sh: line 9: 2132000 Aborted                 (core dumped) RUST_BACKTRACE=full PANIC=$panic $bin

------------- PANIC=untracked ./forge-debuginfo-unwind
The application panicked (crashed).
Message:  align_offset: align is not a power-of-two
Location: /rustc/62d7ed4a6775c4490e493093ca98ef7c215b835b/library/core/src/ptr/const_ptr.rs:1368

This is a bug. Consider reporting it at https://github.com/foundry-rs/foundry

  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                ⋮ 7 frames hidden ⋮                               
   8: forge::main::h5069bbdeccde792d
      at <unknown source file>:<unknown line>
   9: std::sys_common::backtrace::__rust_begin_short_backtrace::h21681e747fd41e51
      at <unknown source file>:<unknown line>
  10: std::rt::lang_start::{{closure}}::h6ed8ba4300b81c2a
      at <unknown source file>:<unknown line>
  11: std::rt::lang_start_internal::hf76339a38b4f124b
      at <unknown source file>:<unknown line>
  12: main<unknown>
      at <unknown source file>:<unknown line>
  13: __libc_start_main<unknown>
      at <unknown source file>:<unknown line>
  14: _start<unknown>
      at <unknown source file>:<unknown line>

Run with COLORBT_SHOW_HIDDEN=1 environment variable to disable frame filtering.

------------- PANIC=untracked ./forge-symbols-abort
The application panicked (crashed).
Message:  align_offset: align is not a power-of-two
Location: /rustc/62d7ed4a6775c4490e493093ca98ef7c215b835b/library/core/src/ptr/const_ptr.rs:1368

This is a bug. Consider reporting it at https://github.com/foundry-rs/foundry

  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
   1: __libc_start_main<unknown>
      at <unknown source file>:<unknown line>

Run with COLORBT_SHOW_HIDDEN=1 environment variable to disable frame filtering.
./test.sh: line 9: 2132151 Aborted                 (core dumped) RUST_BACKTRACE=full PANIC=$panic $bin

------------- PANIC=untracked ./forge-symbols-unwind
The application panicked (crashed).
Message:  align_offset: align is not a power-of-two
Location: /rustc/62d7ed4a6775c4490e493093ca98ef7c215b835b/library/core/src/ptr/const_ptr.rs:1368

This is a bug. Consider reporting it at https://github.com/foundry-rs/foundry

  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
   1: __libc_start_main<unknown>
      at <unknown source file>:<unknown line>

Run with COLORBT_SHOW_HIDDEN=1 environment variable to disable frame filtering.

------------
44M     ./forge-debuginfo-abort
52M     ./forge-debuginfo-unwind
40M     ./forge-symbols-abort
47M     ./forge-symbols-unwind

Evalir
Evalir approved these changes Jan 24, 2024
View reviewed changes
Copy link
Member

@Evalir Evalir left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Def prefer this

@DaniPopes DaniPopes merged commit 8972a9f into master Jan 24, 2024
@DaniPopes DaniPopes deleted the dani/keep-symbols branch January 24, 2024 21:45
@DaniPopes DaniPopes mentioned this pull request Jan 29, 2024
Merged
This was referenced Apr 26, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Evalir Evalir Evalir approved these changes

@mattsse mattsse Awaiting requested review from mattsse mattsse is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@DaniPopes @Evalir